home *** CD-ROM | disk | FTP | other *** search
/ Software of the Month Club 2000 October / Software of the Month - Ultimate Collection Shareware 277.iso / pc / PROGRAMS / UTILITY / WINLINUX / DATA1.CAB / programs_-_include / LINUX / MTIO.H < prev    next >
C/C++ Source or Header  |  1999-09-17  |  14KB  |  374 lines
  1. /* 
  2.  * linux/mtio.h header file for Linux. Written by H. Bergman
  3.  *
  4.  * Modified for special ioctls provided by zftape in September 1997
  5.  * by C.-J. Heine.
  6.  */
  7.  
  8. #ifndef _LINUX_MTIO_H
  9. #define _LINUX_MTIO_H
  10.  
  11. #include <linux/types.h>
  12. #include <linux/ioctl.h>
  13. #include <linux/qic117.h>
  14.  
  15. /*
  16.  * Structures and definitions for mag tape io control commands
  17.  */
  18.  
  19. /* structure for MTIOCTOP - mag tape op command */
  20. struct    mtop {
  21.     short    mt_op;        /* operations defined below */
  22.     int    mt_count;    /* how many of them */
  23. };
  24.  
  25. /* Magnetic Tape operations [Not all operations supported by all drivers]: */
  26. #define MTRESET 0    /* +reset drive in case of problems */
  27. #define MTFSF    1    /* forward space over FileMark,
  28.              * position at first record of next file 
  29.              */
  30. #define MTBSF    2    /* backward space FileMark (position before FM) */
  31. #define MTFSR    3    /* forward space record */
  32. #define MTBSR    4    /* backward space record */
  33. #define MTWEOF    5    /* write an end-of-file record (mark) */
  34. #define MTREW    6    /* rewind */
  35. #define MTOFFL    7    /* rewind and put the drive offline (eject?) */
  36. #define MTNOP    8    /* no op, set status only (read with MTIOCGET) */
  37. #define MTRETEN 9    /* retension tape */
  38. #define MTBSFM    10    /* +backward space FileMark, position at FM */
  39. #define MTFSFM  11    /* +forward space FileMark, position at FM */
  40. #define MTEOM    12    /* goto end of recorded media (for appending files).
  41.              * MTEOM positions after the last FM, ready for
  42.              * appending another file.
  43.              */
  44. #define MTERASE 13    /* erase tape -- be careful! */
  45.  
  46. #define MTRAS1  14    /* run self test 1 (nondestructive) */
  47. #define MTRAS2    15    /* run self test 2 (destructive) */
  48. #define MTRAS3  16    /* reserved for self test 3 */
  49.  
  50. #define MTSETBLK 20    /* set block length (SCSI) */
  51. #define MTSETDENSITY 21    /* set tape density (SCSI) */
  52. #define MTSEEK    22    /* seek to block (Tandberg, etc.) */
  53. #define MTTELL    23    /* tell block (Tandberg, etc.) */
  54. #define MTSETDRVBUFFER 24 /* set the drive buffering according to SCSI-2 */
  55.             /* ordinary buffered operation with code 1 */
  56. #define MTFSS    25    /* space forward over setmarks */
  57. #define MTBSS    26    /* space backward over setmarks */
  58. #define MTWSM    27    /* write setmarks */
  59.  
  60. #define MTLOCK  28    /* lock the drive door */
  61. #define MTUNLOCK 29    /* unlock the drive door */
  62. #define MTLOAD  30    /* execute the SCSI load command */
  63. #define MTUNLOAD 31    /* execute the SCSI unload command */
  64. #define MTCOMPRESSION 32/* control compression with SCSI mode page 15 */
  65. #define MTSETPART 33    /* Change the active tape partition */
  66. #define MTMKPART  34    /* Format the tape with one or two partitions */
  67.  
  68. /* structure for MTIOCGET - mag tape get status command */
  69.  
  70. struct    mtget {
  71.     long    mt_type;    /* type of magtape device */
  72.     long    mt_resid;    /* residual count: (not sure)
  73.                  *    number of bytes ignored, or
  74.                  *    number of files not skipped, or
  75.                  *    number of records not skipped.
  76.                  */
  77.     /* the following registers are device dependent */
  78.     long    mt_dsreg;    /* status register */
  79.     long    mt_gstat;    /* generic (device independent) status */
  80.     long    mt_erreg;    /* error register */
  81.     /* The next two fields are not always used */
  82.     __kernel_daddr_t mt_fileno;    /* number of current file on tape */
  83.     __kernel_daddr_t mt_blkno;    /* current block number */
  84. };
  85.  
  86.  
  87.  
  88. /*
  89.  * Constants for mt_type. Not all of these are supported,
  90.  * and these are not all of the ones that are supported.
  91.  */
  92. #define MT_ISUNKNOWN        0x01
  93. #define MT_ISQIC02        0x02    /* Generic QIC-02 tape streamer */
  94. #define MT_ISWT5150        0x03    /* Wangtek 5150EQ, QIC-150, QIC-02 */
  95. #define MT_ISARCHIVE_5945L2    0x04    /* Archive 5945L-2, QIC-24, QIC-02? */
  96. #define MT_ISCMSJ500        0x05    /* CMS Jumbo 500 (QIC-02?) */
  97. #define MT_ISTDC3610        0x06    /* Tandberg 6310, QIC-24 */
  98. #define MT_ISARCHIVE_VP60I    0x07    /* Archive VP60i, QIC-02 */
  99. #define MT_ISARCHIVE_2150L    0x08    /* Archive Viper 2150L */
  100. #define MT_ISARCHIVE_2060L    0x09    /* Archive Viper 2060L */
  101. #define MT_ISARCHIVESC499    0x0A    /* Archive SC-499 QIC-36 controller */
  102. #define MT_ISQIC02_ALL_FEATURES    0x0F    /* Generic QIC-02 with all features */
  103. #define MT_ISWT5099EEN24    0x11    /* Wangtek 5099-een24, 60MB, QIC-24 */
  104. #define MT_ISTEAC_MT2ST        0x12    /* Teac MT-2ST 155mb drive, Teac DC-1 card (Wangtek type) */
  105. #define MT_ISEVEREX_FT40A    0x32    /* Everex FT40A (QIC-40) */
  106. #define MT_ISDDS1        0x51    /* DDS device without partitions */
  107. #define MT_ISDDS2        0x52    /* DDS device with partitions */
  108. #define MT_ISSCSI1        0x71    /* Generic ANSI SCSI-1 tape unit */
  109. #define MT_ISSCSI2        0x72    /* Generic ANSI SCSI-2 tape unit */
  110.  
  111. /* QIC-40/80/3010/3020 ftape supported drives.
  112.  * 20bit vendor ID + 0x800000 (see ftape-vendors.h)
  113.  */
  114. #define MT_ISFTAPE_UNKNOWN    0x800000 /* obsolete */
  115. #define MT_ISFTAPE_FLAG    0x800000
  116.  
  117. struct mt_tape_info {
  118.     long t_type;        /* device type id (mt_type) */
  119.     char *t_name;        /* descriptive name */
  120. };
  121.  
  122. #define MT_TAPE_INFO    { \
  123.     {MT_ISUNKNOWN,        "Unknown type of tape device"}, \
  124.     {MT_ISQIC02,        "Generic QIC-02 tape streamer"}, \
  125.     {MT_ISWT5150,        "Wangtek 5150, QIC-150"}, \
  126.     {MT_ISARCHIVE_5945L2,    "Archive 5945L-2"}, \
  127.     {MT_ISCMSJ500,        "CMS Jumbo 500"}, \
  128.     {MT_ISTDC3610,        "Tandberg TDC 3610, QIC-24"}, \
  129.     {MT_ISARCHIVE_VP60I,    "Archive VP60i, QIC-02"}, \
  130.     {MT_ISARCHIVE_2150L,    "Archive Viper 2150L"}, \
  131.     {MT_ISARCHIVE_2060L,    "Archive Viper 2060L"}, \
  132.     {MT_ISARCHIVESC499,    "Archive SC-499 QIC-36 controller"}, \
  133.     {MT_ISQIC02_ALL_FEATURES, "Generic QIC-02 tape, all features"}, \
  134.     {MT_ISWT5099EEN24,    "Wangtek 5099-een24, 60MB"}, \
  135.     {MT_ISTEAC_MT2ST,    "Teac MT-2ST 155mb data cassette drive"}, \
  136.     {MT_ISEVEREX_FT40A,    "Everex FT40A, QIC-40"}, \
  137.     {MT_ISSCSI1,        "Generic SCSI-1 tape"}, \
  138.     {MT_ISSCSI2,        "Generic SCSI-2 tape"}, \
  139.     {0, NULL} \
  140. }
  141.  
  142.  
  143. /* structure for MTIOCPOS - mag tape get position command */
  144.  
  145. struct    mtpos {
  146.     long     mt_blkno;    /* current block number */
  147. };
  148.  
  149.  
  150. /* structure for MTIOCGETCONFIG/MTIOCSETCONFIG primarily intended
  151.  * as an interim solution for QIC-02 until DDI is fully implemented.
  152.  */
  153. struct mtconfiginfo {
  154.     long    mt_type;    /* drive type */
  155.     long    ifc_type;    /* interface card type */
  156.     unsigned short    irqnr;    /* IRQ number to use */
  157.     unsigned short    dmanr;    /* DMA channel to use */
  158.     unsigned short    port;    /* IO port base address */
  159.  
  160.     unsigned long    debug;    /* debugging flags */
  161.  
  162.     unsigned    have_dens:1;
  163.     unsigned    have_bsf:1;
  164.     unsigned    have_fsr:1;
  165.     unsigned    have_bsr:1;
  166.     unsigned    have_eod:1;
  167.     unsigned    have_seek:1;
  168.     unsigned    have_tell:1;
  169.     unsigned    have_ras1:1;
  170.     unsigned    have_ras2:1;
  171.     unsigned    have_ras3:1;
  172.     unsigned    have_qfa:1;
  173.  
  174.     unsigned    pad1:5;
  175.     char        reserved[10];
  176. };
  177.  
  178. /*  structure for MTIOCVOLINFO, query information about the volume
  179.  *  currently positioned at (zftape)
  180.  */
  181. struct mtvolinfo {
  182.     unsigned int mt_volno;   /* vol-number */
  183.     unsigned int mt_blksz;   /* blocksize used when recording */
  184.     unsigned int mt_rawsize; /* raw tape space consumed, in kb */
  185.     unsigned int mt_size;    /* volume size after decompression, in kb */
  186.     unsigned int mt_cmpr:1;  /* this volume has been compressed */
  187. };
  188.  
  189. /* raw access to a floppy drive, read and write an arbitrary segment.
  190.  * For ftape/zftape to support formatting etc.
  191.  */
  192. #define MT_FT_RD_SINGLE  0
  193. #define MT_FT_RD_AHEAD   1
  194. #define MT_FT_WR_ASYNC   0 /* start tape only when all buffers are full     */
  195. #define MT_FT_WR_MULTI   1 /* start tape, continue until buffers are empty  */
  196. #define MT_FT_WR_SINGLE  2 /* write a single segment and stop afterwards    */
  197. #define MT_FT_WR_DELETE  3 /* write deleted data marks, one segment at time */
  198.  
  199. struct mtftseg
  200. {            
  201.     unsigned mt_segno;   /* the segment to read or write */
  202.     unsigned mt_mode;    /* modes for read/write (sync/async etc.) */
  203.     int      mt_result;  /* result of r/w request, not of the ioctl */
  204.     void    *mt_data;    /* User space buffer: must be 29kb */
  205. };
  206.  
  207. /* get tape capacity (ftape/zftape)
  208.  */
  209. struct mttapesize {
  210.     unsigned long mt_capacity; /* entire, uncompressed capacity 
  211.                     * of a cartridge
  212.                     */
  213.     unsigned long mt_used;     /* what has been used so far, raw 
  214.                     * uncompressed amount
  215.                     */
  216. };
  217.  
  218. /*  possible values of the ftfmt_op field
  219.  */
  220. #define FTFMT_SET_PARMS        1 /* set software parms */
  221. #define FTFMT_GET_PARMS        2 /* get software parms */
  222. #define FTFMT_FORMAT_TRACK    3 /* start formatting a tape track   */
  223. #define FTFMT_STATUS        4 /* monitor formatting a tape track */
  224. #define FTFMT_VERIFY        5 /* verify the given segment        */
  225.  
  226. struct ftfmtparms {
  227.     unsigned char  ft_qicstd;   /* QIC-40/QIC-80/QIC-3010/QIC-3020 */
  228.     unsigned char  ft_fmtcode;  /* Refer to the QIC specs */
  229.     unsigned char  ft_fhm;      /* floppy head max */
  230.     unsigned char  ft_ftm;      /* floppy track max */
  231.     unsigned short ft_spt;      /* segments per track */
  232.     unsigned short ft_tpc;      /* tracks per cartridge */
  233. };
  234.  
  235. struct ftfmttrack {
  236.     unsigned int  ft_track;   /* track to format */
  237.     unsigned char ft_gap3;    /* size of gap3, for FORMAT_TRK */
  238. };
  239.  
  240. struct ftfmtstatus {
  241.     unsigned int  ft_segment;  /* segment currently being formatted */
  242. };
  243.  
  244. struct ftfmtverify {
  245.     unsigned int  ft_segment;   /* segment to verify */
  246.     unsigned long ft_bsm;       /* bsm as result of VERIFY cmd */
  247. };
  248.  
  249. struct mtftformat {
  250.     unsigned int fmt_op;      /* operation to perform */
  251.     union fmt_arg {
  252.         struct ftfmtparms  fmt_parms;  /* format parameters */
  253.         struct ftfmttrack  fmt_track;  /* ctrl while formatting */
  254.         struct ftfmtstatus fmt_status;
  255.         struct ftfmtverify fmt_verify; /* for verifying */ 
  256.     } fmt_arg;
  257. };
  258.  
  259. struct mtftcmd {
  260.     unsigned int ft_wait_before; /* timeout to wait for drive to get ready 
  261.                       * before command is sent. Milliseconds
  262.                       */
  263.     qic117_cmd_t ft_cmd;         /* command to send */
  264.     unsigned char ft_parm_cnt;   /* zero: no parm is sent. */
  265.     unsigned char ft_parms[3];   /* parameter(s) to send to
  266.                       * the drive. The parms are nibbles
  267.                       * driver sends cmd + 2 step pulses */
  268.     unsigned int ft_result_bits; /* if non zero, number of bits
  269.                       *    returned by the tape drive
  270.                       */
  271.     unsigned int ft_result;      /* the result returned by the tape drive*/
  272.     unsigned int ft_wait_after;  /* timeout to wait for drive to get ready
  273.                       * after command is sent. 0: don't wait */
  274.     int ft_status;                 /* status returned by ready wait
  275.                       * undefined if timeout was 0.
  276.                       */
  277.     int ft_error;                /* error code if error status was set by 
  278.                       * command
  279.                       */
  280. };
  281.  
  282. /* mag tape io control commands */
  283. #define    MTIOCTOP    _IOW('m', 1, struct mtop)    /* do a mag tape op */
  284. #define    MTIOCGET    _IOR('m', 2, struct mtget)    /* get tape status */
  285. #define    MTIOCPOS    _IOR('m', 3, struct mtpos)    /* get tape position */
  286.  
  287. /* The next two are used by the QIC-02 driver for runtime reconfiguration.
  288.  * See tpqic02.h for struct mtconfiginfo.
  289.  */
  290. #define    MTIOCGETCONFIG    _IOR('m', 4, struct mtconfiginfo) /* get tape config */
  291. #define    MTIOCSETCONFIG    _IOW('m', 5, struct mtconfiginfo) /* set tape config */
  292.  
  293. /* the next six are used by the floppy ftape drivers and its frontends
  294.  * sorry, but MTIOCTOP commands are write only.
  295.  */
  296. #define    MTIOCRDFTSEG    _IOWR('m', 6, struct mtftseg)  /* read a segment */
  297. #define    MTIOCWRFTSEG    _IOWR('m', 7, struct mtftseg)   /* write a segment */
  298. #define MTIOCVOLINFO    _IOR('m',  8, struct mtvolinfo) /* info about volume */
  299. #define MTIOCGETSIZE    _IOR('m',  9, struct mttapesize)/* get cartridge size*/
  300. #define MTIOCFTFORMAT   _IOWR('m', 10, struct mtftformat) /* format ftape */
  301. #define MTIOCFTCMD    _IOWR('m', 11, struct mtftcmd) /* send QIC-117 cmd */
  302.  
  303. /* Generic Mag Tape (device independent) status macros for examining
  304.  * mt_gstat -- HP-UX compatible.
  305.  * There is room for more generic status bits here, but I don't
  306.  * know which of them are reserved. At least three or so should
  307.  * be added to make this really useful.
  308.  */
  309. #define GMT_EOF(x)              ((x) & 0x80000000)
  310. #define GMT_BOT(x)              ((x) & 0x40000000)
  311. #define GMT_EOT(x)              ((x) & 0x20000000)
  312. #define GMT_SM(x)               ((x) & 0x10000000)  /* DDS setmark */
  313. #define GMT_EOD(x)              ((x) & 0x08000000)  /* DDS EOD */
  314. #define GMT_WR_PROT(x)          ((x) & 0x04000000)
  315. /* #define GMT_ ?         ((x) & 0x02000000) */
  316. #define GMT_ONLINE(x)           ((x) & 0x01000000)
  317. #define GMT_D_6250(x)           ((x) & 0x00800000)
  318. #define GMT_D_1600(x)           ((x) & 0x00400000)
  319. #define GMT_D_800(x)            ((x) & 0x00200000)
  320. /* #define GMT_ ?         ((x) & 0x00100000) */
  321. /* #define GMT_ ?         ((x) & 0x00080000) */
  322. #define GMT_DR_OPEN(x)          ((x) & 0x00040000)  /* door open (no tape) */
  323. /* #define GMT_ ?         ((x) & 0x00020000) */
  324. #define GMT_IM_REP_EN(x)        ((x) & 0x00010000)  /* immediate report mode */
  325. /* 16 generic status bits unused */
  326.  
  327.  
  328. /* SCSI-tape specific definitions */
  329. /* Bitfield shifts in the status  */
  330. #define MT_ST_BLKSIZE_SHIFT    0
  331. #define MT_ST_BLKSIZE_MASK    0xffffff
  332. #define MT_ST_DENSITY_SHIFT    24
  333. #define MT_ST_DENSITY_MASK    0xff000000
  334.  
  335. #define MT_ST_SOFTERR_SHIFT    0
  336. #define MT_ST_SOFTERR_MASK    0xffff
  337.  
  338. /* Bitfields for the MTSETDRVBUFFER ioctl */
  339. #define MT_ST_OPTIONS        0xf0000000
  340. #define MT_ST_BOOLEANS        0x10000000
  341. #define MT_ST_SETBOOLEANS    0x30000000
  342. #define MT_ST_CLEARBOOLEANS    0x40000000
  343. #define MT_ST_WRITE_THRESHOLD    0x20000000
  344. #define MT_ST_DEF_BLKSIZE    0x50000000
  345. #define MT_ST_DEF_OPTIONS    0x60000000
  346. #define MT_ST_TIMEOUTS        0x70000000
  347. #define MT_ST_SET_TIMEOUT    (MT_ST_TIMEOUTS | 0x000000)
  348. #define MT_ST_SET_LONG_TIMEOUT    (MT_ST_TIMEOUTS | 0x100000)
  349.  
  350. #define MT_ST_BUFFER_WRITES    0x1
  351. #define MT_ST_ASYNC_WRITES    0x2
  352. #define MT_ST_READ_AHEAD    0x4
  353. #define MT_ST_DEBUGGING        0x8
  354. #define MT_ST_TWO_FM        0x10
  355. #define MT_ST_FAST_MTEOM    0x20
  356. #define MT_ST_AUTO_LOCK        0x40
  357. #define MT_ST_DEF_WRITES    0x80
  358. #define MT_ST_CAN_BSR        0x100
  359. #define MT_ST_NO_BLKLIMS    0x200
  360. #define MT_ST_CAN_PARTITIONS    0x400
  361. #define MT_ST_SCSI2LOGICAL      0x800
  362. #define MT_ST_SYSV              0x1000
  363.  
  364. /* The mode parameters to be controlled. Parameter chosen with bits 20-28 */
  365. #define MT_ST_CLEAR_DEFAULT    0xfffff
  366. #define MT_ST_DEF_DENSITY    (MT_ST_DEF_OPTIONS | 0x100000)
  367. #define MT_ST_DEF_COMPRESSION    (MT_ST_DEF_OPTIONS | 0x200000)
  368. #define MT_ST_DEF_DRVBUFFER    (MT_ST_DEF_OPTIONS | 0x300000)
  369.  
  370. /* The offset for the arguments for the special HP changer load command. */
  371. #define MT_ST_HPLOADER_OFFSET 10000
  372.  
  373. #endif /* _LINUX_MTIO_H */
  374.